<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2011 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except<a name="line.4"></a>
<span class="sourceLineNo">005</span> * in compliance with the License. You may obtain a copy of the License at<a name="line.5"></a>
<span class="sourceLineNo">006</span> *<a name="line.6"></a>
<span class="sourceLineNo">007</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * Unless required by applicable law or agreed to in writing, software distributed under the License<a name="line.9"></a>
<span class="sourceLineNo">010</span> * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express<a name="line.10"></a>
<span class="sourceLineNo">011</span> * or implied. See the License for the specific language governing permissions and limitations under<a name="line.11"></a>
<span class="sourceLineNo">012</span> * the License.<a name="line.12"></a>
<span class="sourceLineNo">013</span> */<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>package com.google.common.hash;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import com.google.common.annotations.Beta;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.Serializable;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * An object which can send data from an object of type {@code T} into a {@code PrimitiveSink}.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;p&gt;Note that serialization of {@linkplain BloomFilter bloom filters} requires the proper<a name="line.24"></a>
<span class="sourceLineNo">025</span> * serialization of funnels. When possible, it is recommended that funnels be implemented as a<a name="line.25"></a>
<span class="sourceLineNo">026</span> * single-element enum to maintain serialization guarantees. See Effective Java (2nd Edition),<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Item 3: "Enforce the singleton property with a private constructor or an enum type". For example:<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;pre&gt;   {@code<a name="line.28"></a>
<span class="sourceLineNo">029</span> *   public enum PersonFunnel implements Funnel&lt;Person&gt; {<a name="line.29"></a>
<span class="sourceLineNo">030</span> *     INSTANCE;<a name="line.30"></a>
<span class="sourceLineNo">031</span> *     public void funnel(Person person, PrimitiveSink into) {<a name="line.31"></a>
<span class="sourceLineNo">032</span> *       into.putString(person.getFirstName())<a name="line.32"></a>
<span class="sourceLineNo">033</span> *           .putString(person.getLastName())<a name="line.33"></a>
<span class="sourceLineNo">034</span> *           .putInt(person.getAge());<a name="line.34"></a>
<span class="sourceLineNo">035</span> *     }<a name="line.35"></a>
<span class="sourceLineNo">036</span> *   }}&lt;/pre&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * <a name="line.37"></a>
<span class="sourceLineNo">038</span> * @author Dimitris Andreou<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @since 11.0<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>@Beta<a name="line.41"></a>
<span class="sourceLineNo">042</span>public interface Funnel&lt;T&gt; extends Serializable {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>  /**<a name="line.44"></a>
<span class="sourceLineNo">045</span>   * Sends a stream of data from the {@code from} object into the sink {@code into}. There<a name="line.45"></a>
<span class="sourceLineNo">046</span>   * is no requirement that this data be complete enough to fully reconstitute the object<a name="line.46"></a>
<span class="sourceLineNo">047</span>   * later.<a name="line.47"></a>
<span class="sourceLineNo">048</span>   *<a name="line.48"></a>
<span class="sourceLineNo">049</span>   * @since 12.0 (in Guava 11.0, {@code PrimitiveSink} was named {@code Sink})<a name="line.49"></a>
<span class="sourceLineNo">050</span>   */<a name="line.50"></a>
<span class="sourceLineNo">051</span>  void funnel(T from, PrimitiveSink into);<a name="line.51"></a>
<span class="sourceLineNo">052</span>}<a name="line.52"></a>




























































</pre>
</div>
</body>
</html>
